home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 3 / The Arsenal Files 3.iso / gen_bbs / imlfa_wb.exe / IMLFA21.DOC < prev    next >
Text File  |  1994-09-09  |  34KB  |  736 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                   -= IMLFA =-
  11.                                     Ver 2.1
  12.  
  13.                       InterMail Log file Analyzer/Reporter
  14.  
  15.                              Copyright(c) 1993-1994
  16.                   Gordon E. Rasnick,  Arctic Computer Services
  17.                               2530 Sebring Circle
  18.                               Anchorage, AK  99516
  19.                               All rights reserved.
  20.  
  21.                               FIDONET (1:3550/559)
  22.                             CompuServe ID: 72007,417
  23.                               *******************
  24.  
  25.              InterMail is Copyright 1988-1994 Scandinavian PC Systems AB
  26.                            & InterZone Software, Inc.
  27.                               All rights reserved.
  28.                               *******************
  29.  
  30. IMLFA version 2.1                                                       Page 1
  31. ------------------------------------------------------------------------------
  32.  
  33.  
  34.      IMLFA is a complete log file analyzer/reporter for the InterMail
  35.      E-mail package.  To make full use of its current features, version
  36.      2.24 or higher of IM is recommended.  Some testing was done
  37.      with earlier IM versions but no compatibility is assumed or implied.
  38.      Care has been taken to attempt to eliminate any conflicts with
  39.      future versions of InterMail log files, should formats change or
  40.      additional information appear.
  41.  
  42.      Please read the documentation carefully.  It is important that both
  43.      IMLFA and InterMail be set up correctly for this system to work
  44.      properly.
  45.  
  46.      This version of IMLFA is not crippled in any way.  All the features
  47.      are enabled in this release.  When you first start it up, you will be
  48.      asked to type in a number to continue.  It will then perform without
  49.      any further intervention.  This random number step will occur each
  50.      time you run IMLFA until you register your copy and receive a
  51.      registration key code.  See REGISTER.DOC for more information.  Your
  52.      registration will disable the random number step, permitting you to
  53.      run it from your batch file during regular nightly maintenance events.
  54.  
  55.      SysOps/IM users....  You may distribute this software via any means
  56.      you desire so long as it is distributed in the original self-extracting
  57.      archive format it was released in, with all files intact and unmodified.
  58.      You may not charge for this distribution with the exception of the cost
  59.      of a distribution disk, if required, plus a minor shipping and
  60.      duplication fee.
  61.  
  62.      Distribution by commercial corporations, companies, governmental
  63.      agencies or educational institutions is prohibited without the
  64.      expressed written consent of the copyright holder.  This is usually
  65.      not a problem, but solely for informational purposes.
  66.  
  67. Page 2                                                       IMLFA version 2.1
  68. ------------------------------------------------------------------------------
  69.  
  70.  
  71.                              *******************
  72.  
  73.                              SYSTEM REQUIREMENTS
  74.  
  75.      IMLFA requires at least 256k of free memory to run and will use
  76.      any free EMS it finds.  The more free conventional memory (0 - 640k)
  77.      it has, the faster it will run.  During beta testing, IMLFA processed
  78.      InterMail log files of over 1 meg in about 3 minutes on a 386/40mhz
  79.      machine with no EMS active.
  80.  
  81.      The 1+ meg log file contained transfer information on over 3000 file
  82.      transfers with a busy HUB.  Since IM's log file contains so much extra
  83.      information, finding info about transfers between this HUB and a
  84.      particular node would be a hair pulling experience.  IMLFA transformed
  85.      this 1 meg log file into a data file 10% of that size, still retaining
  86.      all the transfer information such as, date, filename, file size,
  87.      start time, stop time, average CPS throughput and connecting node.
  88.      IMLFA will even flag you in its reports if a failed file transfer
  89.      occurred and record the connect speeds of all your transfers.
  90.  
  91.      Once this data is imported into IMLFA, reports can be produced to
  92.      provide you with information on your system's connects.  The comments
  93.      in the IMLFA.CFG file explain in detail the types of reports available.
  94.  
  95.      NOTES:  IMLFA must be run from its own directory.  It does not
  96.              search paths for the IMLFA.* files.  Change to the IMLFA
  97.              directory before running this program.
  98.  
  99.              When passing command line parameters with options, make
  100.              sure that no spaces exists in the passed string.  ie...
  101.  
  102.                           IMLFA -IC:\IM\NODE2\LOG.IM2
  103.  
  104.  
  105.              IMLFA does not modify InterMail's log file in any way.  It
  106.              does however, expect the InterMail log file to contain
  107.              certain information.  This may mean that you will have to
  108.              modify your setup in IMSETUP to accommodate this program.
  109.              This is explained in detail in the IMLFA.CFG file.
  110.  
  111.              If you find that you aren't getting what you expected out
  112.              of this program, look in the IMLFA directory for a file
  113.              called IMLFA.ERR.  It will be created if trouble arises and
  114.              provide you with information as to what the problem was.
  115.  
  116. IMLFA version 2.1                                                       Page 3
  117. ------------------------------------------------------------------------------
  118.  
  119.  
  120.                              *******************
  121.  
  122.  
  123.                               GETTING STARTED.
  124.  
  125.      1.  Create a directory on your hard disk called IMLFA.
  126.          MD\IMLFA
  127.  
  128.      2.  Copy all the files from this archive to that directory.
  129.          COPY *.* \IMLFA
  130.  
  131.      3.  Edit the IMLFA.CFG file to set up the system for the type
  132.          of reports you wish to produce, the paths and filenames.  IMLFA.CFG
  133.          is heavily commented and also serves as additional documentation
  134.          for the program.  Read it carefully and verify that all the
  135.          paths you specify actually exist and are spelled correctly.
  136.  
  137.          You may now run IMLFA by passing any of the following command
  138.          line parameters.
  139.  
  140.          NOTE:  STACKING COMMAND LINE PARAMETERS IS NOT PERMITTED.
  141.  
  142.  
  143.       o  IMLFA -?  produces a short screen of information on all of the
  144.          available command line switches and associated options.
  145.  
  146.       o  IMLFA -B will back up the IM log file to the path specified in the
  147.          BACKFILE statement in the IMLFA.CFG file.   This option is very
  148.          handy in several ways.  First, after calling IMLFA -I to process
  149.          your IM log file, you need to make sure that the log file is no
  150.          longer available to be processed again.  Using the -B switch will
  151.          take care of that for you.  Secondly, it will give you a means
  152.          to recover your log file should you need to.
  153.  
  154.          The -B switch also accepts an optional log file name to backup.
  155.          IMLFA -Bc:\im\node2\log.im2 will override the default log file
  156.          name defined in IMLFA.CFG.
  157.  
  158.            (Also see the AUTO BACKUP statement in the IMLFA.CFG file.)
  159.  
  160.          IMLFA uses a date naming convention you can understand.  Assume
  161.          today's date is 01/02/93, it is just after midnight and you drop
  162.          out of the mailer to process the log file.  After running IMLFA
  163.          with the -I switch, you run it again with -B, which renames the
  164.          LOG.IM2 file to 01-01-93.IM2 and moves it to the directory you
  165.          specified in IMLFA.CFG.  Once all your processing is completed and
  166.          your batch file restarts IM, a new log file is created.
  167.  
  168.       o  IMLFA -C creates a report in the same format as the detailed
  169.          report described below, but includes a Billing Total for the
  170.          node based on either Total Bytes transferred or Total Connect
  171.          time.  Also see the "Billing" section below.
  172.  
  173. Page 4                                                       IMLFA version 2.1
  174. ------------------------------------------------------------------------------
  175.  
  176.  
  177.       o  IMLFA -D permits you to create detailed reports for transfers
  178.          with your connecting nodes.  By default, IMLFA looks for a file
  179.          named DETAIL.CFG in the current directory.  DETAIL.CFG is a pure
  180.          ascii file and contains a list of the nodes you wish to have
  181.          reports created for, and the path\filename for each node.  The
  182.          format is:
  183.  
  184.          1:234/567=c:\imlfa\reports\john
  185.          1:234/568=c:\imlfa\reports\mike
  186.  
  187.          Use no filename extension here.  Those are created as .IN and
  188.          .OUT files.
  189.  
  190.          You can also use this file to create a billing report by placing
  191.          the -C switch ahead of the node number.
  192.  
  193.          -C1:234/569=c:\imlfa\reports\dave
  194.  
  195.          There is no practical limit to the number of nodes you may list
  196.          in DETAIL.CFG and it can contain both regular and billing options
  197.          at the same time.
  198.  
  199.          You may also pass an alternate path\filename as an option to -D.
  200.  
  201.          IMLFA -Dc:\imlfa\alter.cfg
  202.  
  203.       o  IMLFA -F produces a detailed report for a particular file.  This
  204.          report shows the node numbers that sent or received the file,
  205.          transfer date, start and stop times for the transfer, cps rate
  206.          and connect speed.  You must pass a full filename (no path) with
  207.          this switch.   Wildcards are not permitted, and the report file
  208.          will be created in the current directory using the current
  209.          filename with an extension of .FLS.  (IMFLA -Fnodelist.zip would
  210.          create the report NODELIST.FLS)
  211.  
  212.       o  IMLFA -I  processes all the data from the current IM log file.
  213.          This obviously should only be done once per day and care should
  214.          be taken to ensure that the log file is deleted, renamed or moved
  215.          out of the way so that the data in it will not be imported again.
  216.                          (See the -B switch below.)
  217.  
  218.          The default InterMail log file name used in this import is
  219.          stored in the IMFLA.CFG file.  Multi-node users can pass an
  220.          option with this switch to process another log file.
  221.                         (IMLFA -Ic:\im\node2\log.im2)
  222.  
  223.       o  IMLFA -M produces a single page summary of miscellaneous system
  224.          information.  There are many useful items such as File Transfer
  225.          totals, System Errors, Outbound call attempts, Inbound call
  226.          attempts, Incoming BBS calls, Connect speeds, etc....  It may
  227.          surprise you when you see just how many times your modem went off
  228.          hook in a single week.  NOTE: If you wish to make full use of this
  229.          report, you should turn on DEBUG mode in the IMSETUP logging options.
  230.  
  231. IMLFA version 2.1                                                       Page 5
  232. ------------------------------------------------------------------------------
  233.  
  234.  
  235.       o  IMLFA -N creates all new index files for the stored data.  If you
  236.          see data that doesn't look quite right, you could have a corrupt
  237.          index.  Run IMLFA with this switch and then try running your
  238.          reports again to see if the problem has been corrected.
  239.  
  240.       o  IMLFA -P produces a detailed report which lists all your outbound
  241.          calls including the phone number dialed.  This can be useful in
  242.          comparing to your monthly phone bill.  To use this option, you
  243.          must have the proper area of IMLFA.CFG configured.  It is
  244.          explained in detail in that file.
  245.  
  246.       o  IMLFA -R will produce a single report of all the traffic between
  247.          you and all other nodes you have had contact with.  You specify
  248.          the filename of this report in the IMLFA.CFG file at the MAIL FILE
  249.          statement.  The filename will always be the same and paths are
  250.          supported here also.  Note that the report is cumulative and shows
  251.          all transfer information with your system since the IMLFA data
  252.          files were created or last purged using the -W switch.
  253.  
  254.          The -R switch also accepts an optional date range for the output,
  255.          or simply call -Rlast for a report of the last day's import.
  256.  
  257.          IMLFA -R01/01/80,01/05/80 will produce a summary report for all
  258.          traffic in that range.  Dates are inclusive.
  259.  
  260.       o  IMLFA -T permits you to insert comments into your IM log file.
  261.          Assume you have an external event set up to process inbound
  262.          TIC's.  IM's log file would probably contain an entry similar to:
  263.  
  264.          -  4:14:01  Executing event #  4, errorlevel: 220
  265.  
  266.          Not very descriptive.   By placing the following at the proper
  267.          location in your batch file, things would be a bit more informative.
  268.  
  269.             REM   Change to the IMLFA dir
  270.                CD\IMLFA
  271.             REM   add comment to log file
  272.                IMLFA -TProcessing_TIC_Files_From_1:234/567
  273.             REM   Change back to the original directory
  274.                CD\IM
  275.             REM   Run TICK
  276.             REM   Change to the IMLFA dir
  277.                CD\IMLFA
  278.             REM   add comment to log file
  279.                IMLFA -TDone_processing_TIC_Files_From_1:234/567
  280.  
  281.                                 (continued)
  282.  
  283. Page 6                                                       IMLFA version 2.1
  284. ------------------------------------------------------------------------------
  285.  
  286.  
  287.  
  288.             IM's log file would now show:
  289.  
  290.             -  4:14:01  Executing event #  4, errorlevel: 220
  291.  
  292.             _  4:14:02  Processing_TIC_Files_From_1:234/567
  293.  
  294.             _  4:20:00  Done_processing_TIC_Files_From_1:234/567
  295.  
  296.           The maximum length of the text string is 60 characters.  Should
  297.           you attempt to write more than that, it will be truncated.
  298.  
  299.           The -T switch will write to the default log file listed in
  300.           IMLFA.CFG but you may also pass an alternate log file name if you
  301.           wish.       (IMLFA -TYour_Comment=C:\IM\NODE2\LOG.IM2)
  302.  
  303.           NOTE:   OS/2 users have the advantage of being able to pass a
  304.                   a string containing spaces, as long as it is enclosed
  305.                   in quotes.
  306.  
  307.                   IMLFA -T"Processing TIC Files From 1:234/567"  will
  308.                   work just fine in an OS/2 DOS box.
  309.  
  310.       o  IMLFA -W is used to wipe out stored data in the system, in effect,
  311.          giving you a clean slate.  CAREFUL!  There is no escape from this
  312.          switch.   Since you want to be able to run it from your batch file,
  313.          NO prompt will be given before the data is removed from the file,
  314.          and that data is gone forever!
  315.  
  316.          The -W switch accepts several options and care should be used when
  317.          calling these.
  318.  
  319.          -W            Deletes all stored File Transfer data.  This would
  320.                        include data for the summary and miscellaneous
  321.                        reports.  Phone number logging data is not affected
  322.                        when calling this.
  323.  
  324.          -WA           Deletes all stored data in all files.
  325.  
  326.          -WP           Deletes all stored phone number data.
  327.  
  328.          -W01/01/80    Deletes all stored file transfer data for a specific
  329.                        date.
  330.  
  331.          -W1:234/567   Deletes all stored file transfer data for a specific
  332.                        node.
  333.  
  334.          The -WA and -WP parameters do not accept additional options and
  335.          none of these options can be stacked on the command line.
  336.  
  337.          The AUTO RESET statement in the IMLFA.CFG file provides additional
  338.          flexibility in keeping data files in order and is documented there.
  339.  
  340. Page 7                                                       IMLFA version 2.1
  341. ------------------------------------------------------------------------------
  342.  
  343.  
  344.       o  IMLFA -ZA may be useful for HUB's wishing to use the reports for
  345.          assisting in spreading out echomail distribution costs.  Since
  346.          IMLFA stores data on all files transferred through your system, the
  347.          data regarding files other than echomail is included in all
  348.          reports.  Calling the -ZA switch will remove all files not
  349.          containing the following extensions from the stored data.
  350.  
  351.                     .SU? .MO? .TU? .WE? .TH? .FR? .SA?
  352.  
  353.          Use the -ZA switch prior to running your reports and you will
  354.          receive a truer picture of just how much echomail distribution
  355.          your system is producing with each of your nodes.
  356.  
  357.  
  358.          You may also pass a file extension if you wish to delete a
  359.          specific file.  Wildcards are supported but be careful!  -ZA.*
  360.          will delete every file in the database if it has an extension,
  361.          including your echomail bundles.
  362.                 (-ZA.D* will delete ALL *.DOC, *.DAT, etc.)
  363.  
  364.       o  IMLFA -ZM will do the reverse of the above -ZA switch.  FILENET
  365.          HUBS may find this useful for creating reports for their downlinks
  366.          regarding the filenet distribution.  Calling this switch will
  367.          delete files with the following extensions:
  368.  
  369.                  .SU?  .MO?  .TU?  .WE?  .TH?  .FR?  .SA?
  370.  
  371.          These are the standard echomail distribution extensions and
  372.          consideration has been given to the instances where the '?' would
  373.          be higher than 9. (A-Z is used in this event.)  Wildcards are also
  374.          acceptable here.
  375.  
  376.       o  IMLFA -1:234/567=JOHN   Will produce a detailed report of the
  377.          traffic between you and John at node 1:234/567.  Two reports
  378.          will be produced, JOHN.IN and JOHN.OUT, which include all
  379.          INbound and OUTbound transfer information.  You may use any legal
  380.          file and path name you wish after the "=" sign, but USE NO
  381.          EXTENSION.  IMLFA -1:234/567=C:\BBS\TXTFILES\JOHN would create
  382.          the report in the directory where you keep your BBS displayable
  383.          text files.         (C:\BBS\TXTFILES\)
  384.  
  385. Page 8                                                       IMLFA version 2.1
  386. ------------------------------------------------------------------------------
  387.  
  388.  
  389.                              *******************
  390.  
  391.                                   SUMMARY
  392.  
  393.      You will probably want to call IMLFA several times in a session,
  394.      first to process and back up the latest InterMail log, then to
  395.      create the reports.
  396.  
  397.      A typical session in your batch file might look something like:
  398.  
  399.    :IMLFA_RUN
  400.  
  401.       REM   Change to the IMLFA directory.  Remember....It doesn't search
  402.       REM   your paths for its files.
  403.          CD\IMLFA
  404.  
  405.       REM   Read in the latest IM log info.
  406.          IMLFA -I
  407.       REM   Read in the log for node 2.
  408.          IMLFA -Ic:\im\node2\log.im2
  409.  
  410.       REM   I'm a Mail HUB so I want to Zap out all files not related to
  411.       REM   Echomail traffic.
  412.          IMLFA -ZA
  413.  
  414.       REM   Produce a detailed report of traffic to and from several nodes.
  415.          IMLFA -Dc:\imlfa\mynet.cfg
  416.  
  417.       REM   Produce a detailed report of traffic to and from 1:234/568
  418.          IMLFA -1:234/568=C:\BBS\TXTFILES\JOE
  419.  
  420.       REM   DITTO
  421.          IMLFA -1:234/569=C:\BBS\TXTFILES\JIM
  422.  
  423.       REM   Produce a summary report of all traffic with all nodes.
  424.       REM   This file is named and stored according to the information
  425.       REM   you provided in the IMLFA.CFG file.
  426.          IMLFA -R
  427.  
  428.       REM   Produce a miscellaneous report of all system activity.
  429.       REM   This file is also named and stored according to the information
  430.       REM   you provided in the IMLFA.CFG file.
  431.          IMLFA -M
  432.  
  433.       REM   Start up BBS/IM again.
  434.          GOTO RECYCLE
  435.  
  436.                                 (continued)
  437.  
  438. IMLFA version 2.1                                                       Page 9
  439. ------------------------------------------------------------------------------
  440.  
  441.  
  442.  
  443.       The entire run above, on a months worth of IM log data, would only
  444.       take a few minutes on a slow machine but you'll probably want to run
  445.       this on a weekly basis or more often if you have a busy system.  Mine
  446.       runs every night and requires only a few seconds to complete.
  447.  
  448.       REGISTERED USERS:
  449.       It is recommended that you create an external event to exit at just
  450.       after midnight to run the program, especially if you intend to use
  451.       the log file backup option. (-B switch)  This would create a more
  452.       realistic backup based on the date used as the filename.
  453.  
  454.  
  455.                              *******************
  456.  
  457.  
  458.                                    BILLING
  459.  
  460.       IMLFA provides two ways to assist in spreading the cost of echomail
  461.       distribution.  Since the data provided by the IM log file is limited,
  462.       so is this program, but with some cooperation from your downlinks, you
  463.       should find it more than adequate.
  464.  
  465.       Cost may be distributed on a Total Connect Time Per Node or Bytes
  466.       Transferred Per Node basis and is configured by the options you
  467.       define for the BILLING command statement in the IMLFA.CFG file.
  468.  
  469.        BILLING=MINS,4
  470.        BILLING=BYTES,4
  471.        BILLING=N       (default)
  472.  
  473.  
  474.       (Remember, you also have the -ZA or -ZM switches for use in removing
  475.       unwanted transfer information from the system.  They give a truer
  476.       picture of transfers for the type of distribution you do.)
  477.  
  478.       My NET uses an averaged Connect Time method which was agreed upon by all
  479.       our nodes.  Data for the cost of importing the echomail was collected
  480.       for several previous months and then averaged to a cost per minute
  481.       among all our nodes.  Yes, some nodes end up paying a bit more for less,
  482.       but we're talking peanuts here, only pennies a day.  It's simple,
  483.       easily verified, and now, automated.  (By the way, our number came to
  484.       about 6.5 cents per minute to each node.  Our net is small and
  485.       long distance charges from Alaska are somewhat higher than the
  486.       continental U.S., but with most of the nodes having 14400 modems,
  487.       they can bring in 10 megs of compressed mail for about $6.00 per month.)
  488.  
  489.                                 (continued)
  490.  
  491. Page 10                                                      IMLFA version 2.1
  492. ------------------------------------------------------------------------------
  493.  
  494.  
  495.       Cost distributed by Bytes is probably the method to use if your
  496.       downlinks use modems of varying speeds or range widely in the amount
  497.       of mail they receive.  It is still an averaged system, but spreads the
  498.       cost more realistically under the above conditions.
  499.  
  500.       The cost per bytes is actually a UNIT which IMLFA defines as 86400
  501.       bytes, or about 1 minute of transfer time at 14400 bps and at 100%
  502.       throughput.  Regardless of what speed a downlink connects at, his
  503.       billing reflects each 86400 byte UNIT and if you have defined that
  504.       unit to be charged at 5 cents, that is the amount his cost share will
  505.       indicate regardless of his connect time.  If he receives 172800 bytes,
  506.       his cost is 10 cents regardless of the length of the connect.
  507.  
  508.       Your task in putting this to work for you is to decide just how much
  509.       to charge, regardless of the method you choose.
  510.  
  511.       The Connect Time method is pretty straight forward.
  512.                   (cost per hour / 60) = cents per minute
  513.       If the number is $3.50 per hour, 5.8 cents per minute is the parameter
  514.       you use in the IMLFA.CFG file.  (BILLING=MINS,5.8)  You're downlinks
  515.       would be charged 5.8 cents for every minute of connect time to you.
  516.  
  517.       The Bytes Transferred method requires a bit more math.
  518.         (your cost / (total bytes from hub / 86400)) / number of downlinks.
  519.       If you received 175,000,000 bytes and divided by 86400, you would have
  520.       approximately 2025 UNITS.  Divide that into your phone charges to your
  521.       HUB, say $205.00, and you have roughly 10.1 cents per unit (your cost).
  522.       (You'll probably notice that if you run a 14400 modem, the cents per
  523.       unit will just about equal your telephone company's rate per minute
  524.       for the call.)  Divide this by your number of downlinks, .101 / 12
  525.       results in $0.008 cents. (BILLING=BYTES,.8)
  526.  
  527.       You can now see why the UNIT was established.  On a true BYTE level,
  528.       you would run out the decimal places beyond what most calculators want
  529.       to deal with.
  530.  
  531.       You may wish to apply other variables to either of the equations.
  532.       These figures aren't cast in stone, but are probably the best that can
  533.       be done given the information the IM Log file provides.  (The only
  534.       truly accurate method involves using packet level software.)
  535.  
  536.       Yes, using the BYTES method, you may actually send out more than
  537.       you receive and end up billing a bit more than you spend, but over
  538.       a period of many months it will probably average out.  Otherwise, you
  539.       can adjust the UNIT cost.  The same holds true for MINS.
  540.  
  541.                                 (continued)
  542.  
  543. IMLFA version 2.1                                                      Page 11
  544. ------------------------------------------------------------------------------
  545.  
  546.  
  547.  
  548.       In our net, all the nodes agreed that if the HUB collects too
  549.       much over the months, everyone would get a freebie or the extra
  550.       funds could be used for a Christmas party.  The idea is to sell the
  551.       system to your downlinks, then let the software do the work.
  552.  
  553.       Should anyone have an idea for another method, we'd love to hear
  554.       about it.  Keep in mind, your IM log file only tracks TIME and BYTES
  555.       accurately.
  556.  
  557.  
  558.  
  559.  
  560.                              ********************
  561.  
  562.  
  563.                                   AUTO MODE
  564.  
  565.       IMLFA has the built in capability to set things up for a
  566.       completely automatic system.  Three options are available in the
  567.       IMLFA.CFG file, AUTO BACKUP, AUTO REPORTS and AUTO RESET.  These
  568.       options are explained in detail in the IMLFA.CFG file.
  569.  
  570.  
  571.  
  572. IMLFA version 2.1                                                      Page 12
  573. ------------------------------------------------------------------------------
  574.  
  575.  
  576.                              ********************
  577.  
  578.  
  579.                            MULTI-NODE CONSIDERATIONS
  580.  
  581.       If you are running a multi-node InterMail system, there are some
  582.       things you may wish to change in your setup to make the most of this
  583.       program.
  584.  
  585.       1.  IMLFA accepts the InterMail Log File name as an option to
  586.           the -I switch, (IMLFA -Ic:\im\node2\log.im2).  If no filename
  587.           is passed, it uses the default in the IMLFA.CFG file.  Assuming
  588.           you are running two nodes, your batch file would look something
  589.           like this:
  590.  
  591.           :IMLFA_RUN
  592.              freenode
  593.              cd\imlfa
  594.                 IMLFA-I
  595.                 IMLFA-Ic:\im\node2\log.im2
  596.                 REM   any other IMLFA switches you require here.
  597.              freenode /u
  598.           goto start_up_im
  599.  
  600.  
  601.       2.  If you intend to use the IM log file backup option in IMLFA (called
  602.           via the -B switch or with the AUTO BACKUP statement in IMLFA.CFG),
  603.           you will need to ensure that each IM log file has a unique
  604.           extension in its filename.  IE:  LOG.IM1, LOG.IM2...
  605.  
  606.           All of this should be set to exit with the appropriate errorlevel
  607.           as soon as possible AFTER midnight.  This gives your backups
  608.           greater accuracy since they are based on the system dates.
  609.           (See the -B switch description in the Available Switches section
  610.           above.)
  611.  
  612.       3.  If more than one node tries to run IMLFA at the same time, the
  613.           node making the second attempt will be put in a holding mode,
  614.           and wait up to 5 minutes for access to the IMLFA data files.  If
  615.           access to the data files cannot be made, it will be recorded in
  616.           the IMLFA.ERR file and IMLFA will return to the batch file without
  617.           doing any further processing.  Gaining access to the IM log file
  618.           is handled in the same manner.
  619.  
  620.           To avoid this type of confusion, you could set the exits from IM
  621.           to occur 2 or 3 minutes apart, but as with all forced events,
  622.           they only happen when the IM node is in a wait state.  If a
  623.           transfer is in progress into and beyond the event, the possibility
  624.           of a clash is quite real.  The 5 minute wait should be sufficient
  625.           for even the slowest systems capable of running multi-node.
  626.  
  627.       4.  Unless you are running multiple copies (and storing multiple IMLFA
  628.           data files for each node), it is strongly recommended that you
  629.           permit only the last exiting node to use AUTO MODE, create daily
  630.           reports or purge data files.  This will help ensure that all
  631.           IM log files have been processed.  (creative use of semaphore
  632.           files here could also prove useful.)
  633.  
  634. Page 13                                                      IMLFA version 2.1
  635. ------------------------------------------------------------------------------
  636.  
  637.  
  638.  
  639.  
  640.                              ********************
  641.  
  642.  
  643.                                 ERROR CHECKING
  644.  
  645.       IMLFA does a minimal amount of error checking as it performs its
  646.       duties.  Sometimes it will complain, sometimes it won't.  This is
  647.       primarily a batch file utility and assumes you have things set up
  648.       properly.  Once it is in place, things shouldn't change very often.
  649.  
  650.       Some of the things it DOES NOT check for:
  651.  
  652.         1.  Paths (directories\sub-directories) for the output of reports.
  653.             Scanning a 1 or 2 gig disk for correct paths every time it is
  654.             started up is a senseless waste of time.  Be sure the paths
  655.             you define actually exist and are spelled correctly since no
  656.             attempt to create one will be made if it doesn't exist and
  657.             no report will be written.
  658.  
  659.         2.  The existence of previously run reports.  They are simply
  660.             overwritten.
  661.  
  662.         3.  The possibility that the IM log file you are about to import
  663.             has already been previously scanned.  If you run IMLFA -I more
  664.             than once on an IM log file, you'll end up with duplicate
  665.             information in the database with no means of purging the dupes.
  666.  
  667.       Some of the things it DOES check for:
  668.  
  669.         1.  All the files it needs to operate properly.  With the exception
  670.             of the IM log file, all other system files must be in the
  671.             current directory and IMLFA must be executed from that directory.
  672.             If it doesn't find the files it needs, it will either try to
  673.             create them, or, in the case of IM's log file, write an error
  674.             message to the IMLFA.ERR file.
  675.  
  676.         2.  An existing IM log file Backup created by using the -B switch.
  677.             You can only use that switch once per day and the IM log file
  678.             is deleted when you do.
  679.  
  680.         3.  Valid node numbers passed as parameters at the command line.
  681.  
  682.  
  683.        There are three possible errorlevels returned to DOS after each run.
  684.  
  685.             ErrorLevel  2   Indicates a system or IM log file not found, or
  686.                             the inability of the program to create a
  687.                             requested report.  This type of error will also
  688.                             create an entry in the IMLFA.ERR file explaining
  689.                             just what type of problem it had.
  690.  
  691.             ErrorLevel  1   Hardware problem was encountered.  This means
  692.                             DISK error.  Disk full or drive door open in
  693.                             the case of a floppy drive.  This error is not
  694.                             written to IMLFA.ERR.
  695.  
  696.             ErrorLevel  0   Is a successful run.
  697. Page 14                                                      IMLFA version 2.1
  698. ------------------------------------------------------------------------------
  699.  
  700.  
  701.                              ********************
  702.  
  703.  
  704.                                 IMLFA SUPPORT
  705.  
  706.       Support is provided via NetMail or written request only.  Responses
  707.       via NetMail are the fastest, usually within 48 hours of receipt here.
  708.  
  709.       If there is a problem with log file imports, please bundle up a copy
  710.       of the full day's IM log file, your IMLFA.CFG file and a copy of the
  711.       report showing the problem, and send them to 1:3550/559.  You do not
  712.       need to send any of the IMLFA data files or other reports.  They can
  713.       be recreated here.
  714.  
  715.       I will also try to answer questions via my CompuServe address (listed
  716.       above) if you so choose, but responses may not be as timely.
  717.  
  718.       Please DO NOT use the FidoNet InterMail echo for this purpose.
  719.       I will not respond to questions or bug reports in that forum.  I do
  720.       this for 2 reasons.  One, echos are cluttered enough without
  721.       addressing the problems of shareware authors.  Two, NetMail responses
  722.       are MUCH faster.
  723.  
  724.       I will provide any help I can at FidoNet 1:3550/559 for as long as I
  725.       remain in the FidoNet organization.  I anticipate that being quite a
  726.       while. :-)
  727.  
  728.       Comments and/or suggestions for new features are welcome at any time.
  729.  
  730.       See REGISTER.DOC, included in this archive, for information on
  731.       obtaining future fixes and/or upgrades.
  732.  
  733.       Enjoy.....
  734.       Gordon
  735.  
  736.